/**
 * This file is part of 1genia trampoline
 * Copyright (C) 2007 1genia (contact@1genia.com)
 *
 * This library is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; version 3 of the License. 
 *
 * This library is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details. 
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; see the file COPYING.TXT.  If not,
 * write to the Free Software Foundation, Inc., 51 Franklin Street,
 * Fifth Floor, Boston, MA 02110-1301, USA. 
 **/
package com.genia.toolbox.web.gwt.form.client.form;

/**
 * An item whose value(s) is an element that can be created through a Form.
 */
public interface SubFormItem
    extends BasicItem
{

  /**
   * returns the policy associated with this sub-form.
   * 
   * @return the policy associated with this sub-form
   */
  public SubFormPolicy getSubFormPolicy();



  /**
   * returns the form identifier of this sub-form.
   * 
   * @return the form identifier of this sub-form
   */
  public String getSubFormIdentifier();



  /**
   * returns whether to display the string returned as suggestion as html
   * string.
   * 
   * @return wether to display the string returned as suggestion as html string
   */
  public boolean isDisplayStringHTML();



  /**
   * returns whether to use a popup window to display the sub form.
   * 
   * @return whether to use a popup window to display the sub form
   */
  public boolean isPopup();
}
